3 * Core installer web interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\MediaWikiServices
;
27 * Class for the core installer web interface.
32 class WebInstaller
extends Installer
{
35 * @var WebInstallerOutput
47 * Cached session array.
54 * Captured PHP error text. Temporary.
61 * The main sequence of page names. These will be displayed in turn.
63 * To add a new installer page:
64 * * Add it to this WebInstaller::$pageSequence property
65 * * Add a "config-page-<name>" message
66 * * Add a "WebInstaller<name>" class
70 public $pageSequence = [
84 * Out of sequence pages, selectable by the user at any time.
88 protected $otherPages = [
93 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
97 * Array of pages which have declared that they have been submitted, have validated
98 * their input, and need no further processing.
102 protected $happyPages;
105 * List of "skipped" pages. These are pages that will automatically continue
106 * to the next page on any GET request. To avoid breaking the "back" button,
107 * they need to be skipped during a back operation.
111 protected $skippedPages;
114 * Flag indicating that session data may have been lost.
118 public $showSessionWarning = false;
121 * Numeric index of the page we're on
125 protected $tabIndex = 1;
128 * Name of the page we're on
132 protected $currentPageName;
135 * @param WebRequest $request
137 public function __construct( WebRequest
$request ) {
138 parent
::__construct();
139 $this->output
= new WebInstallerOutput( $this );
140 $this->request
= $request;
144 $wgParser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
145 $wgParser->setHook( 'doclink', [ $this, 'docLink' ] );
151 * @param array[] $session Initial session array
153 * @return array[] New session array
155 public function execute( array $session ) {
156 $this->session
= $session;
158 if ( isset( $session['settings'] ) ) {
159 $this->settings
= $session['settings'] +
$this->settings
;
160 // T187586 MediaWikiServices works with globals
161 foreach ( $this->settings
as $key => $val ) {
162 $GLOBALS[$key] = $val;
166 $this->setupLanguage();
168 if ( ( $this->getVar( '_InstallDone' ) ||
$this->getVar( '_UpgradeDone' ) )
169 && $this->request
->getVal( 'localsettings' )
172 return $this->session
;
175 $isCSS = $this->request
->getVal( 'css' );
178 return $this->session
;
181 $this->happyPages
= $session['happyPages'] ??
[];
183 $this->skippedPages
= $session['skippedPages'] ??
[];
185 $lowestUnhappy = $this->getLowestUnhappy();
187 # Special case for Creative Commons partner chooser box.
188 if ( $this->request
->getVal( 'SubmitCC' ) ) {
189 $page = $this->getPageByName( 'Options' );
190 $this->output
->useShortHeader();
191 $this->output
->allowFrames();
194 return $this->finish();
197 if ( $this->request
->getVal( 'ShowCC' ) ) {
198 $page = $this->getPageByName( 'Options' );
199 $this->output
->useShortHeader();
200 $this->output
->allowFrames();
201 $this->output
->addHTML( $page->getCCDoneBox() );
203 return $this->finish();
207 $pageName = $this->request
->getVal( 'page' );
209 if ( in_array( $pageName, $this->otherPages
) ) {
212 $page = $this->getPageByName( $pageName );
215 if ( !$pageName ||
!in_array( $pageName, $this->pageSequence
) ) {
216 $pageId = $lowestUnhappy;
218 $pageId = array_search( $pageName, $this->pageSequence
);
221 # If necessary, move back to the lowest-numbered unhappy page
222 if ( $pageId > $lowestUnhappy ) {
223 $pageId = $lowestUnhappy;
224 if ( $lowestUnhappy == 0 ) {
225 # Knocked back to start, possible loss of session data.
226 $this->showSessionWarning
= true;
230 $pageName = $this->pageSequence
[$pageId];
231 $page = $this->getPageByName( $pageName );
234 # If a back button was submitted, go back without submitting the form data.
235 if ( $this->request
->wasPosted() && $this->request
->getBool( 'submit-back' ) ) {
236 if ( $this->request
->getVal( 'lastPage' ) ) {
237 $nextPage = $this->request
->getVal( 'lastPage' );
238 } elseif ( $pageId !== false ) {
240 # Skip the skipped pages
241 $nextPageId = $pageId;
245 $nextPage = $this->pageSequence
[$nextPageId];
246 } while ( isset( $this->skippedPages
[$nextPage] ) );
248 $nextPage = $this->pageSequence
[$lowestUnhappy];
251 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
253 return $this->finish();
257 $this->currentPageName
= $page->getName();
258 $this->startPageWrapper( $pageName );
260 if ( $page->isSlow() ) {
261 $this->disableTimeLimit();
264 $result = $page->execute();
266 $this->endPageWrapper();
268 if ( $result == 'skip' ) {
269 # Page skipped without explicit submission.
270 # Skip it when we click "back" so that we don't just go forward again.
271 $this->skippedPages
[$pageName] = true;
272 $result = 'continue';
274 unset( $this->skippedPages
[$pageName] );
277 # If it was posted, the page can request a continue to the next page.
278 if ( $result === 'continue' && !$this->output
->headerDone() ) {
279 if ( $pageId !== false ) {
280 $this->happyPages
[$pageId] = true;
283 $lowestUnhappy = $this->getLowestUnhappy();
285 if ( $this->request
->getVal( 'lastPage' ) ) {
286 $nextPage = $this->request
->getVal( 'lastPage' );
287 } elseif ( $pageId !== false ) {
288 $nextPage = $this->pageSequence
[$pageId +
1];
290 $nextPage = $this->pageSequence
[$lowestUnhappy];
293 if ( array_search( $nextPage, $this->pageSequence
) > $lowestUnhappy ) {
294 $nextPage = $this->pageSequence
[$lowestUnhappy];
297 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
300 return $this->finish();
304 * Find the next page in sequence that hasn't been completed
307 public function getLowestUnhappy() {
308 if ( count( $this->happyPages
) == 0 ) {
311 return max( array_keys( $this->happyPages
) ) +
1;
316 * Start the PHP session. This may be called before execute() to start the PHP session.
321 public function startSession() {
322 if ( wfIniGetBool( 'session.auto_start' ) ||
session_id() ) {
327 $this->phpErrors
= [];
328 set_error_handler( [ $this, 'errorHandler' ] );
330 session_name( 'mw_installer_session' );
332 } catch ( Exception
$e ) {
333 restore_error_handler();
336 restore_error_handler();
338 if ( $this->phpErrors
) {
346 * Get a hash of data identifying this MW installation.
348 * This is used by mw-config/index.php to prevent multiple installations of MW
349 * on the same cookie domain from interfering with each other.
353 public function getFingerprint() {
354 // Get the base URL of the installation
355 $url = $this->request
->getFullRequestURL();
356 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
360 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
361 // This... seems to try to get the base path from
362 // the /mw-config/index.php. Kinda scary though?
366 return md5( serialize( [
367 'local path' => dirname( __DIR__
),
369 'version' => $GLOBALS['wgVersion']
374 * Show an error message in a box. Parameters are like wfMessage(), or
375 * alternatively, pass a Message object in.
376 * @param string|Message $msg
378 public function showError( $msg /*...*/ ) {
379 if ( !( $msg instanceof Message
) ) {
380 $args = func_get_args();
381 array_shift( $args );
382 $args = array_map( 'htmlspecialchars', $args );
383 $msg = wfMessage( $msg, $args );
385 $text = $msg->useDatabase( false )->plain();
386 $this->output
->addHTML( $this->getErrorBox( $text ) );
390 * Temporary error handler for session start debugging.
392 * @param int $errno Unused
393 * @param string $errstr
395 public function errorHandler( $errno, $errstr ) {
396 $this->phpErrors
[] = $errstr;
400 * Clean up from execute()
404 public function finish() {
405 $this->output
->output();
407 $this->session
['happyPages'] = $this->happyPages
;
408 $this->session
['skippedPages'] = $this->skippedPages
;
409 $this->session
['settings'] = $this->settings
;
411 return $this->session
;
415 * We're restarting the installation, reset the session, happyPages, etc
417 public function reset() {
419 $this->happyPages
= [];
420 $this->settings
= [];
424 * Get a URL for submission back to the same script.
426 * @param string[] $query
430 public function getUrl( $query = [] ) {
431 $url = $this->request
->getRequestURL();
432 # Remove existing query
433 $url = preg_replace( '/\?.*$/', '', $url );
436 $url .= '?' . wfArrayToCgi( $query );
443 * Get a WebInstallerPage by name.
445 * @param string $pageName
446 * @return WebInstallerPage
448 public function getPageByName( $pageName ) {
449 $pageClass = 'WebInstaller' . $pageName;
451 return new $pageClass( $this );
455 * Get a session variable.
457 * @param string $name
458 * @param array|null $default
462 public function getSession( $name, $default = null ) {
463 return $this->session
[$name] ??
$default;
467 * Set a session variable.
469 * @param string $name Key for the variable
470 * @param mixed $value
472 public function setSession( $name, $value ) {
473 $this->session
[$name] = $value;
477 * Get the next tabindex attribute value.
481 public function nextTabIndex() {
482 return $this->tabIndex++
;
486 * Initializes language-related variables.
488 public function setupLanguage() {
489 global $wgLang, $wgContLang, $wgLanguageCode;
491 if ( $this->getSession( 'test' ) === null && !$this->request
->wasPosted() ) {
492 $wgLanguageCode = $this->getAcceptLanguage();
493 $wgLang = Language
::factory( $wgLanguageCode );
494 RequestContext
::getMain()->setLanguage( $wgLang );
495 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
496 $this->setVar( '_UserLang', $wgLanguageCode );
498 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
500 $wgContLang = MediaWikiServices
::getInstance()->getContentLanguage();
504 * Retrieves MediaWiki language from Accept-Language HTTP header.
508 public function getAcceptLanguage() {
509 global $wgLanguageCode, $wgRequest;
511 $mwLanguages = Language
::fetchLanguageNames( null, 'mwfile' );
512 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
514 foreach ( $headerLanguages as $lang ) {
515 if ( isset( $mwLanguages[$lang] ) ) {
520 return $wgLanguageCode;
524 * Called by execute() before page output starts, to show a page list.
526 * @param string $currentPageName
528 private function startPageWrapper( $currentPageName ) {
529 $s = "<div class=\"config-page-wrapper\">\n";
530 $s .= "<div class=\"config-page\">\n";
531 $s .= "<div class=\"config-page-list\"><ul>\n";
534 foreach ( $this->pageSequence
as $id => $pageName ) {
535 $happy = !empty( $this->happyPages
[$id] );
536 $s .= $this->getPageListItem(
538 $happy ||
$lastHappy == $id - 1,
547 $s .= "</ul><br/><ul>\n";
548 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
550 $s .= "</ul></div>\n";
553 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
554 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
555 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
556 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
557 $s .= Html
::element( 'h2', [],
558 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
560 $this->output
->addHTMLNoFlush( $s );
564 * Get a list item for the page list.
566 * @param string $pageName
567 * @param bool $enabled
568 * @param string $currentPageName
572 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
573 $s = "<li class=\"config-page-list-item\">";
576 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
577 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
578 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
579 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
580 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
583 $query = [ 'page' => $pageName ];
585 if ( !in_array( $pageName, $this->pageSequence
) ) {
586 if ( in_array( $currentPageName, $this->pageSequence
) ) {
587 $query['lastPage'] = $currentPageName;
590 $link = Html
::element( 'a',
592 'href' => $this->getUrl( $query )
597 $link = htmlspecialchars( $name );
600 if ( $pageName == $currentPageName ) {
601 $s .= "<span class=\"config-page-current\">$link</span>";
606 $s .= Html
::element( 'span',
608 'class' => 'config-page-disabled'
620 * Output some stuff after a page is finished.
622 private function endPageWrapper() {
623 $this->output
->addHTMLNoFlush(
624 "<div class=\"visualClear\"></div>\n" .
626 "<div class=\"visualClear\"></div>\n" .
631 * Get HTML for an error box with an icon.
633 * @param string $text Wikitext, get this with wfMessage()->plain()
637 public function getErrorBox( $text ) {
638 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
642 * Get HTML for a warning box with an icon.
644 * @param string $text Wikitext, get this with wfMessage()->plain()
648 public function getWarningBox( $text ) {
649 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
653 * Get HTML for an info box with an icon.
655 * @param string $text Wikitext, get this with wfMessage()->plain()
656 * @param string|bool $icon Icon name, file in mw-config/images. Default: false
657 * @param string|bool $class Additional class name to add to the wrapper div. Default: false.
661 public function getInfoBox( $text, $icon = false, $class = false ) {
662 $text = $this->parse( $text, true );
663 $icon = ( $icon == false ) ?
664 'images/info-32.png' :
666 $alt = wfMessage( 'config-information' )->text();
668 return Html
::infoBox( $text, $icon, $alt, $class );
672 * Get small text indented help for a preceding form field.
673 * Parameters like wfMessage().
678 public function getHelpBox( $msg /*, ... */ ) {
679 $args = func_get_args();
680 array_shift( $args );
681 $args = array_map( 'htmlspecialchars', $args );
682 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
683 $html = $this->parse( $text, true );
685 return "<div class=\"config-help-field-container\">\n" .
686 "<span class=\"config-help-field-hint\" title=\"" .
687 wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
688 wfMessage( 'config-help' )->escaped() . "</span>\n" .
689 "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
695 * @param string $msg Key for wfMessage()
697 public function showHelpBox( $msg /*, ... */ ) {
698 $args = func_get_args();
699 $html = $this->getHelpBox( ...$args );
700 $this->output
->addHTML( $html );
704 * Show a short informational message.
705 * Output looks like a list.
709 public function showMessage( $msg /*, ... */ ) {
710 $args = func_get_args();
711 array_shift( $args );
712 $html = '<div class="config-message">' .
713 $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
715 $this->output
->addHTML( $html );
719 * @param Status $status
721 public function showStatusMessage( Status
$status ) {
722 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
723 foreach ( $errors as $error ) {
724 $this->showMessage( ...$error );
729 * Label a control by wrapping a config-input div around it and putting a
733 * @param string $forId
734 * @param string $contents
735 * @param string $helpData
738 public function label( $msg, $forId, $contents, $helpData = "" ) {
739 if ( strval( $msg ) == '' ) {
740 $labelText = "\u{00A0}";
742 $labelText = wfMessage( $msg )->escaped();
745 $attributes = [ 'class' => 'config-label' ];
748 $attributes['for'] = $forId;
751 return "<div class=\"config-block\">\n" .
752 " <div class=\"config-block-label\">\n" .
759 " <div class=\"config-block-elements\">\n" .
766 * Get a labelled text box to configure a variable.
768 * @param mixed[] $params
770 * var: The variable to be configured (required)
771 * label: The message name for the label (required)
772 * attribs: Additional attributes for the input element (optional)
773 * controlName: The name for the input element (optional)
774 * value: The current value of the variable (optional)
775 * help: The html for the help text (optional)
779 public function getTextBox( $params ) {
780 if ( !isset( $params['controlName'] ) ) {
781 $params['controlName'] = 'config_' . $params['var'];
784 if ( !isset( $params['value'] ) ) {
785 $params['value'] = $this->getVar( $params['var'] );
788 if ( !isset( $params['attribs'] ) ) {
789 $params['attribs'] = [];
791 if ( !isset( $params['help'] ) ) {
792 $params['help'] = "";
797 $params['controlName'],
799 $params['controlName'],
800 30, // intended to be overridden by CSS
802 $params['attribs'] +
[
803 'id' => $params['controlName'],
804 'class' => 'config-input-text',
805 'tabindex' => $this->nextTabIndex()
813 * Get a labelled textarea to configure a variable
815 * @param mixed[] $params
817 * var: The variable to be configured (required)
818 * label: The message name for the label (required)
819 * attribs: Additional attributes for the input element (optional)
820 * controlName: The name for the input element (optional)
821 * value: The current value of the variable (optional)
822 * help: The html for the help text (optional)
826 public function getTextArea( $params ) {
827 if ( !isset( $params['controlName'] ) ) {
828 $params['controlName'] = 'config_' . $params['var'];
831 if ( !isset( $params['value'] ) ) {
832 $params['value'] = $this->getVar( $params['var'] );
835 if ( !isset( $params['attribs'] ) ) {
836 $params['attribs'] = [];
838 if ( !isset( $params['help'] ) ) {
839 $params['help'] = "";
844 $params['controlName'],
846 $params['controlName'],
850 $params['attribs'] +
[
851 'id' => $params['controlName'],
852 'class' => 'config-input-text',
853 'tabindex' => $this->nextTabIndex()
861 * Get a labelled password box to configure a variable.
863 * Implements password hiding
864 * @param mixed[] $params
866 * var: The variable to be configured (required)
867 * label: The message name for the label (required)
868 * attribs: Additional attributes for the input element (optional)
869 * controlName: The name for the input element (optional)
870 * value: The current value of the variable (optional)
871 * help: The html for the help text (optional)
875 public function getPasswordBox( $params ) {
876 if ( !isset( $params['value'] ) ) {
877 $params['value'] = $this->getVar( $params['var'] );
880 if ( !isset( $params['attribs'] ) ) {
881 $params['attribs'] = [];
884 $params['value'] = $this->getFakePassword( $params['value'] );
885 $params['attribs']['type'] = 'password';
887 return $this->getTextBox( $params );
891 * Get a labelled checkbox to configure a boolean variable.
893 * @param mixed[] $params
895 * var: The variable to be configured (required)
896 * label: The message name for the label (required)
897 * labelAttribs:Additional attributes for the label element (optional)
898 * attribs: Additional attributes for the input element (optional)
899 * controlName: The name for the input element (optional)
900 * value: The current value of the variable (optional)
901 * help: The html for the help text (optional)
905 public function getCheckBox( $params ) {
906 if ( !isset( $params['controlName'] ) ) {
907 $params['controlName'] = 'config_' . $params['var'];
910 if ( !isset( $params['value'] ) ) {
911 $params['value'] = $this->getVar( $params['var'] );
914 if ( !isset( $params['attribs'] ) ) {
915 $params['attribs'] = [];
917 if ( !isset( $params['help'] ) ) {
918 $params['help'] = "";
920 if ( !isset( $params['labelAttribs'] ) ) {
921 $params['labelAttribs'] = [];
923 $labelText = $params['rawtext'] ??
$this->parse( wfMessage( $params['label'] )->text() );
925 return "<div class=\"config-input-check\">\n" .
929 $params['labelAttribs'],
931 $params['controlName'],
933 $params['attribs'] +
[
934 'id' => $params['controlName'],
935 'tabindex' => $this->nextTabIndex(),
944 * Get a set of labelled radio buttons.
946 * @param mixed[] $params
948 * var: The variable to be configured (required)
949 * label: The message name for the label (required)
950 * itemLabelPrefix: The message name prefix for the item labels (required)
951 * itemLabels: List of message names to use for the item labels instead
952 * of itemLabelPrefix, keyed by values
953 * values: List of allowed values (required)
954 * itemAttribs: Array of attribute arrays, outer key is the value name (optional)
955 * commonAttribs: Attribute array applied to all items
956 * controlName: The name for the input element (optional)
957 * value: The current value of the variable (optional)
958 * help: The html for the help text (optional)
962 public function getRadioSet( $params ) {
963 $items = $this->getRadioElements( $params );
965 $label = $params['label'] ??
'';
967 if ( !isset( $params['controlName'] ) ) {
968 $params['controlName'] = 'config_' . $params['var'];
971 if ( !isset( $params['help'] ) ) {
972 $params['help'] = "";
976 foreach ( $items as $value => $item ) {
977 $s .= "<li>$item</li>\n";
981 return $this->label( $label, $params['controlName'], $s, $params['help'] );
985 * Get a set of labelled radio buttons. You probably want to use getRadioSet(), not this.
989 * @param mixed[] $params
992 public function getRadioElements( $params ) {
993 if ( !isset( $params['controlName'] ) ) {
994 $params['controlName'] = 'config_' . $params['var'];
997 if ( !isset( $params['value'] ) ) {
998 $params['value'] = $this->getVar( $params['var'] );
1003 foreach ( $params['values'] as $value ) {
1006 if ( isset( $params['commonAttribs'] ) ) {
1007 $itemAttribs = $params['commonAttribs'];
1010 if ( isset( $params['itemAttribs'][$value] ) ) {
1011 $itemAttribs = $params['itemAttribs'][$value] +
$itemAttribs;
1014 $checked = $value == $params['value'];
1015 $id = $params['controlName'] . '_' . $value;
1016 $itemAttribs['id'] = $id;
1017 $itemAttribs['tabindex'] = $this->nextTabIndex();
1020 Xml
::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1022 Xml
::tags( 'label', [ 'for' => $id ], $this->parse(
1023 isset( $params['itemLabels'] ) ?
1024 wfMessage( $params['itemLabels'][$value] )->plain() :
1025 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1033 * Output an error or warning box using a Status object.
1035 * @param Status $status
1037 public function showStatusBox( $status ) {
1038 if ( !$status->isGood() ) {
1039 $text = $status->getWikiText();
1041 if ( $status->isOK() ) {
1042 $box = $this->getWarningBox( $text );
1044 $box = $this->getErrorBox( $text );
1047 $this->output
->addHTML( $box );
1052 * Convenience function to set variables based on form data.
1053 * Assumes that variables containing "password" in the name are (potentially
1056 * @param string[] $varNames
1057 * @param string $prefix The prefix added to variables to obtain form names
1061 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1064 foreach ( $varNames as $name ) {
1065 $value = $this->request
->getVal( $prefix . $name );
1066 // T32524, do not trim passwords
1067 if ( stripos( $name, 'password' ) === false ) {
1068 $value = trim( $value );
1070 $newValues[$name] = $value;
1072 if ( $value === null ) {
1074 $this->setVar( $name, false );
1076 if ( stripos( $name, 'password' ) !== false ) {
1077 $this->setPassword( $name, $value );
1079 $this->setVar( $name, $value );
1088 * Helper for Installer::docLink()
1090 * @param string $page
1094 protected function getDocUrl( $page ) {
1095 $query = [ 'page' => $page ];
1097 if ( in_array( $this->currentPageName
, $this->pageSequence
) ) {
1098 $query['lastPage'] = $this->currentPageName
;
1101 return $this->getUrl( $query );
1105 * Extension tag hook for a documentation link.
1107 * @param string $linkText
1108 * @param string[] $attribs
1109 * @param Parser $parser Unused
1113 public function docLink( $linkText, $attribs, $parser ) {
1114 $url = $this->getDocUrl( $attribs['href'] );
1116 return Html
::element( 'a', [ 'href' => $url ], $linkText );
1120 * Helper for "Download LocalSettings" link on WebInstall_Complete
1122 * @param string $text Unused
1123 * @param string[] $attribs Unused
1124 * @param Parser $parser Unused
1126 * @return string Html for download link
1128 public function downloadLinkHook( $text, $attribs, $parser ) {
1129 $anchor = Html
::rawElement( 'a',
1130 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1131 wfMessage( 'config-download-localsettings' )->parse()
1134 return Html
::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1138 * If the software package wants the LocalSettings.php file
1139 * to be placed in a specific location, override this function
1140 * (see mw-config/overrides/README) to return the path of
1141 * where the file should be saved, or false for a generic
1142 * "in the base of your install"
1145 * @return string|bool
1147 public function getLocalSettingsLocation() {
1154 public function envCheckPath() {
1155 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1156 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1157 // to get the path to the current script... hopefully it's reliable. SIGH
1159 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1160 $path = $_SERVER['PHP_SELF'];
1161 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1162 $path = $_SERVER['SCRIPT_NAME'];
1164 if ( $path === false ) {
1165 $this->showError( 'config-no-uri' );
1169 return parent
::envCheckPath();
1172 public function envPrepPath() {
1173 parent
::envPrepPath();
1174 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1175 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1176 // to get the path to the current script... hopefully it's reliable. SIGH
1178 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1179 $path = $_SERVER['PHP_SELF'];
1180 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1181 $path = $_SERVER['SCRIPT_NAME'];
1183 if ( $path !== false ) {
1184 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1186 $this->setVar( 'wgScriptPath', "$scriptPath" );
1187 // Update variables set from Setup.php that are derived from wgScriptPath
1188 $this->setVar( 'wgScript', "$scriptPath/index.php" );
1189 $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1190 $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1191 $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1192 $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1193 $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1194 $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1201 protected function envGetDefaultServer() {
1202 return WebRequest
::detectServer();
1206 * Actually output LocalSettings.php for download
1208 * @suppress SecurityCheck-XSS
1210 private function outputLS() {
1211 $this->request
->response()->header( 'Content-type: application/x-httpd-php' );
1212 $this->request
->response()->header(
1213 'Content-Disposition: attachment; filename="LocalSettings.php"'
1216 $ls = InstallerOverrides
::getLocalSettingsGenerator( $this );
1217 $rightsProfile = $this->rightsProfiles
[$this->getVar( '_RightsProfile' )];
1218 foreach ( $rightsProfile as $group => $rightsArr ) {
1219 $ls->setGroupRights( $group, $rightsArr );
1221 echo $ls->getText();
1225 * Output stylesheet for web installer pages
1227 public function outputCss() {
1228 $this->request
->response()->header( 'Content-type: text/css' );
1229 echo $this->output
->getCSS();
1235 public function getPhpErrors() {
1236 return $this->phpErrors
;